Skip to content

GRPC and JSON Socket docs. - #859

Merged
jnfrati merged 4 commits into
netbirdio:mainfrom
PizzaLovingNerd:json-socket
Jul 22, 2026
Merged

GRPC and JSON Socket docs.#859
jnfrati merged 4 commits into
netbirdio:mainfrom
PizzaLovingNerd:json-socket

Conversation

@PizzaLovingNerd

@PizzaLovingNerd PizzaLovingNerd commented Jul 17, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator
  • Add a gRPC daemon socket guide covering default addresses, custom Unix and TCP listeners, available service methods, grpcurl examples, integration guidance, and troubleshooting.
  • Add an HTTP/JSON daemon socket guide covering enablement, custom listeners, curl and Python examples, gRPC-to-HTTP method mapping, streaming behavior, and troubleshooting.
  • Add both guides to the Client sidebar navigation and cross-link them so readers can choose the appropriate local daemon API.
  • Document the authentication and TLS limitations of both socket interfaces and recommend restricting TCP listeners to trusted interfaces.

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

Summary by CodeRabbit

  • New Features
    • Added documentation for connecting integrations and development tools to the local daemon through gRPC.
    • Added documentation for using the local HTTP/JSON socket as an alternative to gRPC.
    • Included configuration guidance, request examples, integration instructions, and troubleshooting steps.
    • Updated the Client documentation navigation to include both gRPC socket and HTTP/JSON socket guides.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7b0e01e3-5080-4fd3-8023-e5c422134a30

📥 Commits

Reviewing files that changed from the base of the PR and between 342dd23 and abc9650.

📒 Files selected for processing (1)
  • src/pages/client/grpc-socket.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/pages/client/grpc-socket.mdx
📝 Walkthrough

Walkthrough

Adds client documentation for connecting to the local NetBird daemon through gRPC and HTTP/JSON sockets, including configuration, examples, integration guidance, streaming behavior, and troubleshooting. Both pages are added to client navigation.

Changes

Daemon socket documentation

Layer / File(s) Summary
gRPC socket documentation
src/components/NavigationDocs.jsx, src/pages/client/grpc-socket.mdx		 Documents platform socket addresses, daemon configuration, service methods, grpcurl usage, client integrations, and troubleshooting; adds navigation links for both socket pages.
HTTP/JSON socket documentation
src/pages/client/json-socket.mdx		 Documents gateway configuration, HTTP endpoint mapping, curl and Python examples, streaming responses, and troubleshooting.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

Poem

A bunny found two sockets bright,
One speaks gRPC, one JSON light.
With curls and channels, paths align,
The daemon’s docs now neatly shine.
Hop, hop—connect with care!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding gRPC and JSON socket documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/pages/client/grpc-socket.mdx

Oops! Something went wrong! :(

ESLint: 9.39.2

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

jnfrati
jnfrati approved these changes Jul 21, 2026
View reviewed changes

@jnfrati jnfrati left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! One small suggestion to make things a bit easier (not sure if wording could be better)

Comment thread src/pages/client/grpc-socket.mdx Outdated
@PizzaLovingNerd @jnfrati
Update src/pages/client/grpc-socket.mdx
abc9650 
Co-authored-by: Nicolas Frati <nicofrati@gmail.com>
@jnfrati
jnfrati merged commit 9516423 into netbirdio:main Jul 22, 2026
3 checks passed
This was referenced Jul 30, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jnfrati jnfrati jnfrati approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@PizzaLovingNerd @jnfrati